feat: Add link checker to Actions #573
Conversation
WalkthroughThis update introduces a GitHub Actions workflow for automated link checking, removes the "Sovereign rollups on Bitcoin with Rollkit" blog post and its references, and updates numerous documentation links for consistency and accuracy. Several markdown files have internal and external links revised or replaced, with some minor formatting edits. Changes
Sequence Diagram(s)sequenceDiagram
participant GitHub
participant Workflow
participant lychee-action
GitHub-->>Workflow: Pull request event (opened/reopened/synchronized/closed)
Workflow->>Workflow: Checkout repository code
Workflow->>lychee-action: Run link checker on markdown files
lychee-action-->>Workflow: Report broken links (if any)
Workflow-->>GitHub: Fail workflow if broken links found
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
pthmas
force-pushed
the
pierrick/external_link_checker
branch
5 times, most recently
from
405d3ad to
b6d8347
Compare
pthmas
force-pushed
the
pierrick/external_link_checker
branch
from
868571f to
6bef6b6
Compare
pthmas
force-pushed
the
pierrick/external_link_checker
branch
2 times, most recently
from
373d3da to
56fa3ea
Compare
pthmas
force-pushed
the
pierrick/external_link_checker
branch
from
56fa3ea to
28d85f6
Compare
pthmas
force-pushed
the
pierrick/external_link_checker
branch
from
28d85f6 to
b13e912
Compare
pthmas
force-pushed
the
pierrick/external_link_checker
branch
from
b13e912 to
1d2c0c0
Compare
pthmas
force-pushed
the
pierrick/external_link_checker
branch
from
1d2c0c0 to
3ab1ffd
Compare
pthmas
force-pushed
the
pierrick/external_link_checker
branch
from
3ab1ffd to
09d4182
Compare
pthmas
force-pushed
the
pierrick/external_link_checker
branch
from
007a4c1 to
9260507
Compare
pthmas
changed the title
pthmas
force-pushed
the
pierrick/external_link_checker
branch
from
b23ea9d to
9c069a7
Compare
|
|
||
| - name: Link Checker | ||
| id: lychee | ||
| uses: lycheeverse/lychee-action@v2 |
Check warning
Code scanning / CodeQL
Unpinned tag for a non-immutable Action in workflow Medium
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
.github/workflows/external-link-check.yml (1)
24-32: Pin the lychee-action to a commit hashSecurity scanners already complain that
lycheeverse/lychee-action@v2is unpinned. Pinning eliminates the risk of a supply-chain attack and silences the alert.- - name: Link Checker - id: lychee - uses: lycheeverse/lychee-action@v2 + - name: Link Checker + id: lychee + # v2.4.0 commit digest as of 2024-07-09 + uses: lycheeverse/lychee-action@e7d8b9d93f8c6c6db9f7d0a4a1f2dc8ff2c6ad9e
🧹 Nitpick comments (13)
tutorials/da/local-da.md (1)
12-12: Prefer extension-less internal links for VitePressUsing
/tutorials/quick-start.mdworks, but VitePress automatically resolves.mdand appends a trailing slash when building clean URLs.
Sticking with/tutorials/quick-startkeeps URLs consistent across the docs site and avoids duplicated “.html” suffixes in the generated output.-[quick start](/tutorials/quick-start.md) +[quick start](/tutorials/quick-start)Same for the
gm-worldreference a few words later.guides/config.md (1)
576-576: Confirm metrics link renders correctlyAbsolute path plus
.mdis fine, but most other links in the docs omit the extension (e.g./guides/metrics).
Recommend aligning for uniformity and to prevent “.html” duplication in the built site.
Feel free to ignore if you deliberately want the explicit file name.blog/rollkit-the-first-sovereign-rollup-framework.md (1)
36-36: Restored plain “BlockSDK” loses useful hyperlinkPreviously this pointed readers to Skip’s docs. Consider retaining the link to keep parity with the surrounding tooling references.
-and BlockSDK +and [BlockSDK](https://docs.skip.money/blocksdk/overview/)tutorials/execution/cosmwasm.md (1)
31-31: Minor: follow existing link styleSame comment as earlier—dropping
.mdkeeps URL styling consistent:-[GM Rollup](/tutorials/gm-world.md) +[GM Rollup](/tutorials/gm-world)learn/about.md (2)
63-64: Minor phrasing issue.“The components used by the Rollkit stack are customizable.”
You might want to append “(see above)” or similar for clarity—otherwise reads abruptly.
97-98: Duplication of “section” wording.Sentence already says “Tutorials section”; consider dropping the second “section” for conciseness.
guides/create-genesis.md (1)
30-31: Sentence casing: “guide” ⇒ lowercase.Nitpick for consistency: “…follow a [guide]…”
tutorials/da/celestia-da.md (1)
49-50: Typo in list item.
gmdCLI originates in the GM world tutorial—consider capitalising “GM” for consistency with branding.tutorials/da/overview.md (1)
61-61: Absolute link ✓ – but keep the trailing slash for DocusaurusUsing
/tutorials/quick-start.mdis fine, however Docusaurus treats trailing slashes & missing.mdconsistently. If other pages still use/tutorials/quick-start/, we’ll have duplicate URLs in the build. Consider standardising on one convention project-wide.guides/restart-rollup.md (2)
50-51: Updated Mocha docs URL may still driftCelestia docs tend to re-organise; pinning to a specific commit or tag (e.g.
https://raw.githubusercontent.com/.../<sha>/...) would make the link checker more stable.
91-91: Minor style nit – “in order to”You can drop “in order” for conciseness.
- you will need to increase the gas fee in order to avoid a + you will need to increase the gas fee to avoid a.github/workflows/external-link-check.yml (1)
21-23: Least-privilege permissions
issues: writeis requested but the issue-creation step is commented out. Remove or scope it behindif:to avoid unnecessarily elevated permissions.learn/stack.md (1)
65-66: Avoid hard-coding GitHub line numbers
manager.go#L101will drift as the file evolves. Dropping the#L101anchor (or linking to a permanent permalink at a commit) prevents inevitable rot:-https://github.com/rollkit/rollkit/blob/main/block/manager.go#L101 +https://github.com/rollkit/rollkit/blob/main/block/manager.go
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
public/bitcoin-rollkit/rollkit-bitcoin-1.pngis excluded by!**/*.pngpublic/bitcoin-rollkit/rollkit-bitcoin-2.pngis excluded by!**/*.pngpublic/bitcoin-rollkit/rollkit-bitcoin.pngis excluded by!**/*.png
📒 Files selected for processing (20)
.github/workflows/external-link-check.yml(1 hunks).vitepress/config.ts(0 hunks)blog/overview.md(0 hunks)blog/rollkit-the-first-sovereign-rollup-framework.md(2 hunks)blog/sovereign-rollups-on-bitcoin.md(0 hunks)guides/config.md(1 hunks)guides/create-genesis.md(2 hunks)guides/cw-orch.md(1 hunks)guides/ibc-connection.md(2 hunks)guides/restart-rollup.md(3 hunks)guides/use-tia-for-gas.md(1 hunks)guides/zkml.md(1 hunks)learn/about.md(3 hunks)learn/stack.md(3 hunks)tutorials/da/celestia-da.md(4 hunks)tutorials/da/local-da.md(1 hunks)tutorials/da/overview.md(2 hunks)tutorials/deploy-overview.md(1 hunks)tutorials/execution/cosmwasm.md(1 hunks)tutorials/sequencing/overview.md(1 hunks)
💤 Files with no reviewable changes (3)
- blog/overview.md
- blog/sovereign-rollups-on-bitcoin.md
- .vitepress/config.ts
🧰 Additional context used
🧠 Learnings (6)
guides/restart-rollup.md (8)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-08T09:26:23.244Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
tutorials/execution/cosmwasm.md (4)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
guides/ibc-connection.md (6)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-08T09:26:23.244Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
guides/use-tia-for-gas.md (10)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/hyperlane-use-tia-for-gas.md:77-82
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the 'hyperlane-use-tia-for-gas.md' guide, it is intentional to include the seed phrase directly in the code examples.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/hyperlane-use-tia-for-gas.md:77-82
Timestamp: 2024-10-08T09:29:26.874Z
Learning: In the 'hyperlane-use-tia-for-gas.md' guide, it is intentional to include the seed phrase directly in the code examples.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-08T09:26:23.244Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
guides/create-genesis.md (4)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-08T09:26:23.244Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config.yaml`, it's intentional to use the same signer phrase across multiple network configurations (`localwasm` and `stride-internal-1`).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
tutorials/da/celestia-da.md (6)
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/relayer.json:1-5
Timestamp: 2024-10-08T09:25:31.642Z
Learning: In the file `guides/assets/hyperlane-use-tia-for-gas/relayer.json`, the settings `"allowLocalCheckpointSyncers": "true"` and `"gasPaymentEnforcement": [{ "type": "none" }]` are intentional.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:29-37
Timestamp: 2024-10-08T09:27:02.351Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to set the multisig threshold to 1 and to only define validators for the `localwasm` network (domain 963).
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-11T19:05:20.591Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
Learnt from: assafmo
PR: rollkit/docs#390
File: guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml:1-23
Timestamp: 2024-10-08T09:26:38.099Z
Learning: In `guides/assets/hyperlane-use-tia-for-gas/hyperlane-config-2.yaml`, it's intentional to use the same mnemonic for both "localwasm" and "stride-internal-1" networks.
🪛 LanguageTool
guides/restart-rollup.md
[style] ~91-~91: Consider a more concise word here.
Context: ..., you will need to increase the gas fee in order to avoid a Code: 19 error. See the [How ...
(IN_ORDER_TO_PREMIUM)
🪛 GitHub Check: CodeQL
.github/workflows/external-link-check.yml
[warning] 28-28: Unpinned tag for a non-immutable Action in workflow
Unpinned 3rd party Action 'Link Checker' step Uses Step: lychee uses 'lycheeverse/lychee-action' with ref 'v2', not a pinned commit hash
🪛 markdownlint-cli2 (0.17.2)
guides/zkml.md
15-15: Inline HTML
Element: ExecutionCallout
(MD033, no-inline-html)
🔇 Additional comments (16)
guides/use-tia-for-gas.md (1)
264-264: Double-check updated Celestia docs pathThe target moved from
/nodes/mocha-testnet#mocha-testnet-faucetto/how-to-guides/mocha-testnet#mocha-testnet-faucet.
I couldn’t find that exact anchor in the new page—please verify the section id still exists, otherwise the hash link will jump to the top instead of the faucet instructions.guides/ibc-connection.md (2)
4-4: Absolute link looks correct—double-check build output.
/tutorials/gm-world.mdresolves in GitHub but, depending on the VitePress config, the.mdsuffix may be stripped in the generated URL. Confirm that the built site doesn’t redirect to.../gm-world.html(resulting in a 404 when the ‑checker runs).
68-70: Consistent path update—good catch.
Change aligns the “tip” with the new canonical link.learn/about.md (1)
17-18: Link update LGTM—confirm anchor presence.The absolute path with
.mdmatches other docs; just make sure the target file still exposes the default#anchor so scrolling works when the site strips extensions.guides/create-genesis.md (1)
9-10: Updated link OK—verify tutorial still covers Ignite context.The new target (
gm-world) is broader than “ignite-rollkit”. Ensure the tutorial still explains Ignite specifics; otherwise readers may be confused.tutorials/da/celestia-da.md (4)
12-13: GM-world link consistent—good.No issues.
39-42: Check new Celestia docs paths.
https://docs.celestia.org/how-to-guides/*was recently moved to/learn/*during docs overhaul. Run lychee or curl to be sure the new endpoints don’t 404.
120-121: Anchor changed—validate redirect.The previous anchor
#namespacesmoved; confirm the revised URL still lands on the “Namespaces” section or update with the current anchor.
149-151: Explorer links: same path-change caveat.As with earlier Celestia docs links, double-check these
how-to-guides/*#explorerstargets survive the site migration.guides/cw-orch.md (1)
248-249: Confirm new paths actually exist incontracts-wsbranchThe examples were moved from
contracts/tocontracts-ws/contracts/. Double-check that thecontracts-wsdirectory is present on themainbranch of the upstream repo; otherwise these links will 404 and the new link-checker workflow will fail the build.tutorials/da/overview.md (1)
75-76: Nice updateSwitching to absolute paths with
.mdensures the new link-checker resolves them correctly. No issues spotted.guides/restart-rollup.md (1)
12-12: Good switch to absolute linkThe updated quick-start link aligns with the rest of the docs, preventing relative-path breakage when the file moves.
tutorials/sequencing/overview.md (1)
29-30: Link targets confirmedThe explicit
.mdextension prevents SSR frameworks from attempting directory resolution; looks good.learn/stack.md (2)
53-54: Verify the new Celestia docs URL
https://docs.celestia.org/tutorials/node-tutorial/looks correct today, but Celestia has re-organised its docs a few times. Please double-check that the link is stable (or pin to a permalink) so the new link checker does not start failing in the near future.
61-62: Link targets a personal feature branch – fragile
https://github.com/rollkit/go-execution-abci/blob/marko/vn/pkg/rpc/core/mempool.goThe
marko/vnbranch appears to be a personal or feature branch rather thanmainor a tagged release.
Once that branch is deleted or force-pushed, the link checker will break. Consider:-https://github.com/rollkit/go-execution-abci/blob/marko/vn/pkg/rpc/core/mempool.go +https://github.com/rollkit/go-execution-abci/blob/main/pkg/rpc/core/mempool.goor pin to a specific commit hash for full stability.
tutorials/deploy-overview.md (1)
19-20: Confirm that adding “.md” does not break VitePress routingVitePress usually resolves
/tutorials/docker-composeautomatically.
With the explicit.md, the generated URL may become/tutorials/docker-compose.md.html, depending on the build config. Make sure the docs site still renders and the new link checker passes.No change requested if it renders correctly.
| This walkthrough assumes you started the Polaris EVM using Rollkit and should be interpreted as a direct continuation of this Polaris EVM and Rollkit guide. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Same issue here—broken discovery path.
Re-link “Polaris EVM and Rollkit guide” so readers can jump directly.
🤖 Prompt for AI Agents
In guides/zkml.md around lines 21 to 22, the reference to the "Polaris EVM and
Rollkit guide" is a broken link. Update this text to include a proper hyperlink
pointing directly to the correct location or URL of the Polaris EVM and Rollkit
guide, enabling readers to navigate there easily.
Overview
This PR adds the lychee link checker as a GitHub Action for this repo.
See: https://github.com/lycheeverse/lychee-action
It also fixes all the dead links to pass the test.
Summary by CodeRabbit
Chores
Documentation